Repository navigation
docs: standardize README and community files - #5
Merged
Merged
Conversation
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
- README: family layout shared by all five Testcontainers modules (org-profile Floci logo header, fixed section order, emulator table with a Supported column, links to the other language modules, trademark footer) - Remove drifting numbers from docs: service counts, timing and size claims, pinned Floci versions in examples - CODE_OF_CONDUCT and SECURITY aligned with floci-aws; SECURITY points at this repo's private vulnerability reporting - CONTRIBUTING: Slack link, DCO sign-off section, no-AI-attribution rule and a security section, keeping the repo-specific build and test guidance - LICENSE copyright holder: Floci and its contributors - Ignore the root /local/ scratch directory - Add CODE_OF_CONDUCT.md, SECURITY.md and .github/CODEOWNERS - Format README code blocks with ruff: ruff 0.16 formats Markdown code blocks, which made ruff format --check fail on main - README and CONTRIBUTING run the dev tools through uv run, so they work after uv sync without activating the virtualenv - Drop the localstack package keyword Signed-off-by: Hector Ventura <hectorvent@gmail.com>
hectorvent
force-pushed
the
docs/standardize-readme
branch
from
October 6, 2026 22:27
c104c8b to
3d7bfc3
Compare
4 of 8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Part of a family-wide docs alignment across the five Floci Testcontainers modules.
CODE_OF_CONDUCT.mdandSECURITY.md(private vulnerability reporting for this repo);CONTRIBUTING.mdgains the Slack link, the DCO sign-off section, the no-AI-attribution rule and a security section, keeping its repo-specific build and test guidance.Floci and its contributors, the same line as every other Floci repo..gitignoreignores the root/local/scratch directory.CODE_OF_CONDUCT.md,SECURITY.mdand.github/CODEOWNERS.main: ruff 0.16 formats Python code blocks inside Markdown, andruff format --check .was failing onREADME.md. The README code blocks are now ruff-formatted. (ruff>=0.4is still unbounded, so a future ruff can do this again; bounding it is left for a separate change.)localstackkeyword frompyproject.toml.Why
The five module READMEs and community files had drifted apart (different headers and section order, hardcoded service counts that were already wrong, missing SECURITY/CODE_OF_CONDUCT, four different LICENSE copyright lines). They now present as one family and link to each other.
Area
Docs and repo hygiene only. No library code changes.
Tests
ruff check .,ruff format --check .,mypy flociandpytest -m "not integration"pass on Linux (Python 3.11, ruff 0.16.10).Refs
No issue; family-wide consistency change.